home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / remote / uo40ra.zip / USERON.DOC < prev    next >
Text File  |  1992-06-12  |  5KB  |  161 lines
  1. %% Useron docu
  2.                                 -=( UserOn )=-
  3.  
  4.  
  5. What is it:
  6. ===========
  7.  
  8. Useron does almost exacly the same as the useron function of RA 1.0. There's
  9. only one single extra: Whenever a user has the 'external util/door' status
  10. UserOn looks in the RA Directory for a file USERDOES.<NodeNr>. This file
  11. may contain a more accurate description of which door that user entered.
  12. RA only reserves a byte and 6 predefined messages for this purpose, and I
  13. as a doorwrite would like to put the name of the program there.. Alas, this
  14. is not possible with RA, so I wrote this little replacement.
  15.  
  16. Source code (pascal)  for putting, reading and writing such a UserDoes file
  17. is included.
  18.  
  19.  
  20. How To:
  21. =======
  22.  
  23. Simply replace the ShowUsers call with a type 7 call with on the optional
  24. dataline:
  25.  
  26.  <Path>UserOn.exe -T:*T -N:*N [-P:*P] [-SYSOP] [-LINES:<NoLines>] [-AKA]
  27.                   [-NOS]
  28.  
  29. (The -P is only nessecary when you use a commport different from the one in the
  30.  Config.ra, the -N:*N should be there, as this program only makes sence in a
  31.  multiline RA setup)
  32.  
  33. -SYSOP    shows the sysop regardless of the config.ra settings
  34. -NOS      turns local sound off
  35. -AKA      Show handles instead of names.
  36. -Lines:   Turns the message to other line option on, and defines the
  37.           maximal number of lines of a message.
  38.  
  39. That's all.
  40.  
  41.  
  42. Programmers:
  43. ============
  44.  
  45. The USERDOES.<NodeNr> file is a simple textfile with only one line of text,
  46. Maximal 70 characters long. (should be enough..;)
  47. It's expected to be found in the directory where the RA environment variable
  48. is pointing to. Note that the <NodeNr> part has NO leading zeros!
  49.  
  50.  UserDoes.1   is a legal name
  51.  UserDoes.001 will never be found.
  52.  
  53.  
  54. If you use the DoIt.Pas unit, things are simpler:
  55.  
  56. Put somewhere in the initialization part of your program the lines:
  57.  
  58. DoIt.Init(2,'Your text which has to appear',D:\SEMAFORE);
  59. DoIt.SetIt;
  60. DoIt.ResetIt('Some other text for the UserDoes string');
  61.  
  62. And at the end of the program a line:
  63.  
  64. DoIt.ClearIt;
  65.  
  66. Even more fun is to update the userdoes during the game, reflecting the
  67. user's score...;) (RA-Pong, and Richard's Faassen's TETRA do this..)
  68.  
  69. CopyWrong: you are encouraged to include this program with your own programs
  70.            as long as you include the WHOLE package......
  71.  
  72.  
  73.  
  74. Using this program with existing utils and doors:
  75. =================================================
  76.  
  77. Well, from a type 7 menuitem with out a batch you're out
  78. of luck until (and IF) the author of the program supports this
  79. way of showing his info. (Unless of course you use the Type 7 to
  80. call a batchfile..;-)
  81.  
  82. From a type 15 things are easier, just put a line :
  83.  
  84.   Echo <The text to appear> > c:\RA\userdoes.%1
  85.  
  86. into the batchfile and things should work! The %1 reflects the nodenr here.
  87.  
  88. At the end of the batch you can delete the file with a simple
  89.  
  90.   del c:\ra\userdoes.%1
  91.  
  92. !!!!  RA 1.10  !!!!
  93.  
  94. RA 1.10 stores the message files in the semafore directory! If you use
  95. this directory, Useron will use it too for the USERDOES and the message
  96. files.
  97.  
  98.  
  99. Utilities:
  100. ==========
  101.  
  102. Wipe110.exe
  103. -----------
  104.  
  105. This is an utility which builds a complete new UserOn.bbs with empty records.
  106. I use it in my autoexec.bat to clean up after rebooting. (In case of a crash)
  107. The usage is simple:  Wipe110 <Number of nodes>
  108.  
  109. MakeDoes.exe
  110. ------------
  111.  
  112. A little utility to make UserDoes and SysDoes files from a batchfile.
  113.  
  114. Syntax:  MakeDoes <Sys|User> <Node> "Message"
  115.  
  116. Where Sys or Node defines the type of file. (SysDoes or UserDoes file)
  117. The Node defines the current node
  118. and the message is the message which is put into the file made.
  119.  
  120. UOFix.exe
  121. ---------
  122.  
  123. An other utility to keep the useron.bbs clean. It looks into the semafore
  124. directory to see for RABUSY semafore files. If a node isn't busy, an empty
  125. record is written into the useron.bbs. I wrote thisone for someone who had
  126. problems with mangled useron.bbs files.
  127.  
  128. Syntax:  UOFix <MaxNodes> <Path to semafore dir>
  129.  
  130. The semafore dir should be the same path as in the config.ra
  131.  
  132. WHOSON.EXE
  133. ----------
  134.  
  135. This is the same kind of program as UserOn.exe but for dos. When started from
  136. the commandline it shows the same kind of info as useron.
  137.  
  138. Syntax:  WhosOn <Time between screenupdates>
  139.  
  140. default value for screen updates is 10 seconds. The time has to be given in
  141. seconds.
  142.  
  143.  
  144. Last words:
  145. ===========
  146.  
  147. Just in case: you're using this program at your own risk! Never will I accept
  148. any responsibility for anything happening due to the behavior of this program!
  149.  
  150. This program is freeware. Do with it whatever you like. and if you are a
  151. door-programmer yourself, consider supporting the idea.. After all,
  152. when the useron info says something like:
  153.  
  154.     > User having a good time playing multiline-tradewars
  155.  
  156. The odds are that other users jump in..;-)
  157.  
  158. Enjoy!
  159.  Gerhard
  160.  
  161.